Skip to content

Add version and status badges to README files#24

Merged
drneox merged 4 commits intomainfrom
copilot/fix-23
Aug 19, 2025
Merged

Add version and status badges to README files#24
drneox merged 4 commits intomainfrom
copilot/fix-23

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 19, 2025

This PR adds version and status badges to both README.md and README.es.md files using shields.io, improving visibility for contributors and users.

Changes Made

Added badges:

  • Version Badge: Displays the current release version from GitHub releases
  • Build Status Badge: Shows the status of the GitHub Actions workflow for Python API tests

Implementation details:

  • Version badge uses https://img.shields.io/github/v/release/drneox/tzu and links to the GitHub releases page
  • Build status badge uses https://img.shields.io/github/actions/workflow/status/drneox/tzu/python-app-test.yml and links to the GitHub Actions workflow
  • Both badges are positioned at the top of the README files for maximum visibility
  • Spanish translations are provided for the badges in README.es.md

Before:

# TZU - Threat Zero Utility 🛡️

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
...

After:

# TZU - Threat Zero Utility 🛡️

[![Version](https://img.shields.io/github/v/release/drneox/tzu)](https://github.com/drneox/tzu/releases)
[![Build Status](https://img.shields.io/github/actions/workflow/status/drneox/tzu/python-app-test.yml)](https://github.com/drneox/tzu/actions/workflows/python-app-test.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
...

The badges integrate seamlessly with the existing badge collection and follow the same shields.io styling conventions used throughout the project.

Fixes #23.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 19, 2025

@drneox 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Co-authored-by: drneox <1235287+drneox@users.noreply.github.com>
Copilot AI changed the title [WIP] Add version and status badges to README Add version and status badges to README files Aug 19, 2025
Copilot AI requested a review from drneox August 19, 2025 07:19
@drneox
Copy link
Copy Markdown
Owner

drneox commented Aug 19, 2025

The version badge does not include pre-releases.
Please update it to use this format so it shows beta versions as well:

[![Version](https://img.shields.io/github/v/release/drneox/tzu?include_prereleases)](https://github.com/drneox/tzu/releases)

@drneox drneox marked this pull request as ready for review August 19, 2025 07:31
@drneox drneox merged commit 279ba9d into main Aug 19, 2025
4 checks passed
@drneox drneox deleted the copilot/fix-23 branch August 22, 2025 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add version and status badges to README

2 participants